-> Create Payment from External Channel (B2BSoft & Evertec) towards Aria
URL
http://[localhost]:[port]/evertec-ux/v1/{businessId}/payment
url Param
| name | type | description | required |
|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, PR, etc.) identifying the business unit. | Y |
| name | value | description | required |
|---|
| client_id | string | The client_id identifying the channel. | Y |
| client_secret | string | Password associated with the client_id. | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server.
Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | Y |
| targetSystem | string | Target system value where entity need to be created , For example "Aria" | Y |
Request
curl --location 'https://localhost:8080/sfdc-ux/v1/PR/payment' \
--header 'client_id: f029036ffc1a4580a0143d800d206547' \
--header 'client_secret: b0ebd441fc6e4e26bcf0b73856b17328' \
--header 'X-Correlation-ID: e8c67e96-0387-4e56-82b8-e83efda9e179' \
--header 'targetSystem: Aria' \
--header 'Content-Type: application/json' \
--data-raw '{
"@type": "invoice",
"correlatorId": "123456707800",
"paymentDate": "2024-10-04T00:00:00Z",
"description": "a payment example",
"account": {
"id": "255853"
},
"amount": {
"value": 1
},
"channel": {
"id": "channel",
"name": "EVERTEC"
},
"@baseType": "payment"
}'
Definitions
| name | type | description | required |
|---|
| correlatorId | string | This code provides a reference correlation to the external payment. This field must be unique for every payment submitted by the client. | Y |
| paymentDate | string | | N |
| description | string | Additional explanatory text relating to this API call | N |
| account | object | An account reference | Y |
| account.id | string | Client-defined account identifier | Y |
| amount | object | A money | Y |
| amount.value | float | The amount of the payment being/to-be made against the outstanding account balance | Y |
| channel | object | A channel reference | N |
| channel.id | string | channel id | N |
| channel.name | string | Name of the channel. | N |
| @baseType | string | Base type | N |
| @type | string | Type | N |
Possible response success
This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.
[ 200 ]
OK - createPayment request processed successfully, response body contains an entity corresponding to the requested resource.
{
"id": "537399680",
"@type": "invoice",
"correlatorId": "123456707800",
"description": "a payment example",
"account": {
"id": "255853"
},
"amount": {
"value": 1
},
"channel": {
"id": "channel",
"name": "EVERTEC"
},
"@baseType": "payment"
}
Definitions
| name | type | description | required |
|---|
| id | string | The unique identifier for a given transaction | N |
| | Appending the request with response (id) | N |
-> Create Payment from Internal Channel (sfdc-b2c, digital & IVR) towards Aria ( Collects or Settle the Account Balance Payment )
URL
http://[localhost]:[port]/tmf-api/paymentManagement/v4/{businessId}/payment
url Param
| name | type | description | required |
|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, PR, etc.) identifying the business unit. | Y |
| name | value | description | required |
|---|
| client_id | string | The client_id identifying the channel. | Y |
| client_secret | string | Password associated with the client_id. | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server.
Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | Y |
Request
{
"account": {
"id": "ARIATESTING013",
"@type": "CustomerAccountRef"
},
"amount": {
"value": 22,
"unit": "USD"
},
"paymentMethod": {
"id": "SALESFORCE003_PM_019",
"@type": "PaymentMethodRef"
},
"channel": {
"id": "channel",
"name": "SFDCB2C"
},
"correlatorId": "67890",
"@type": "Payment"
}
Definitions
| name | type | description | required |
|---|
| correlatorId | string | | N |
| account | Object | An account reference | Y |
| account.id | string | Client-defined account identifier | Y |
| account.@type | string | Account type | N |
| amount | Object | A Money | N |
| amount.value | float | The amount of money to collect from the account. | N |
| amount.unit | string | Currency | N |
| paymentMethod | Object | A payment method ref or value | N |
| paymentMethod.id | string | Client-defined ID for this payment method. | Y |
| paymentMethod.@type | string | Reference of paymentMethod | N |
| channel | Object | A channel reference | N |
| channel.id | string | channel id | N |
| channel.name | string | Client-defined unique identifier used to track related system actions | N |
| @type | string | Payment type | N |
Possible response success
This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.
[ 200 ]
OK - createPayment request processed successfully, response body contains an entity corresponding to the requested resource.
{
"id": "1678885760.10433",
"authorizationCode": "67890",
"description": "509842214",
"status": "done",
"statusDate": "2023-03-15T13:09:20Z",
"account": {
"id": "ARIATESTING013",
"@type": "CustomerAccountRef"
},
"amount": {
"value": 22,
"unit": "USD"
},
"paymentMethod": {
"id": "SALESFORCE003_PM_019",
"@type": "PaymentMethodRef"
},
"channel": {
"id": "channel",
"name": "SFDCB2C"
},
"correlatorId": "67890",
"@type": "Payment"
}
Definitions
| name | type | description | required |
|---|
| id | string | The unique identifier for a given transaction | N |
| authorizationCode | string | Authorization code provided by the issuing bank | N |
| description | string | The unique identifier for a given transaction | N |
| status | string | Transaction status | N |
| statusDate | string | Current date, UTC format | N |
| | Appending the request with response (id) | N |